gtkgesture: Add note to gtk_gesture_get_bounding_box()

This is the only function that's will be semantically confusing
with touchpad gesture events, explain what's to be expected there.

diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c
index 03733a30f9a8cad870695e35ac192af586bb92ab..f3556de718042c957eb20f00dbdd8399990d3fbd 100644 (file)
--- a/gtk/gtkgesture.c
+++ b/gtk/gtkgesture.c
@@ -1352,6 +1352,12 @@ _gtk_gesture_get_last_update_time (GtkGesture       *gesture,
  * box containing all active touches. Otherwise, %FALSE will be
  * returned.
  *
+ * Note: This function will yield unexpected results on touchpad
+ * gestures. Since there is no correlation between physical and
+ * pixel distances, these will look as if constrained in an
+ * infinitely small area, @rect width and height will thus be 0
+ * regardless of the number of touchpoints.
+ *
  * Returns: %TRUE if there are active touches, %FALSE otherwise
  *
  * Since: 3.14